xenstore: document the xenstore protocol
authorKeir Fraser <keir.fraser@citrix.com>
Wed, 5 Dec 2007 11:08:07 +0000 (11:08 +0000)
committerKeir Fraser <keir.fraser@citrix.com>
Wed, 5 Dec 2007 11:08:07 +0000 (11:08 +0000)
commitc5f554d5c14726ad02f8539a8af352d70a8be733
tree21376417e7097247df1ee3fc95acfdaad11d1171
parent1bb3512f969b20f229cdc092e94afab888dac317
xenstore: document the xenstore protocol

The attached patch adds a new text file docs/misc/xenstore.txt which
describes the actual protocol implemented by xenstored.  This was
reverse-engineered from the actual code in tools/xenstore.

I didn't bother making any automatic arrangements to ensure that the
implemented and documented protocols are kept in step (for example,
automatic code generation, etc.)  The protocol is rather messy
unfortunately and unsuitable for an xdr approach, and in any case is
not likely to change very quickly.

Also in this patch are a couple of comments for xenstored_core.c which
help clarify the behaviour of some payload parsing helper functions.

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
docs/misc/xenstore.txt [new file with mode: 0644]
tools/xenstore/xenstored_core.c